Skip to main content
Glama
hyperspell

hyperspell-mcp

Official
by hyperspell

Add Memory

Store plain text documents or memories in Hyperspell to connect AI applications with unstructured data.

Instructions

Add a plain text document or memory to Hyperspell.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
textYes
titleNo

Implementation Reference

  • The core handler function that implements the logic for the 'Add Memory' tool by calling the Hyperspell API to add a text document or memory.
    def add_memory(text: str, title: str | None = None) -> DocumentStatus:
        """Add a plain text document or memory to Hyperspell."""
        r = mcp.api.documents.add(
            text=text, collection=mcp.config.collection, title=title, source="mcp"
        )
        return DocumentStatus.from_pydantic(r)
  • Registers the 'add_memory' function as the MCP tool named 'Add Memory' using the @mcp.tool decorator.
    @mcp.tool(
        name="Add Memory",
        description="Add a plain text document or memory to Hyperspell.",
    )
  • Pydantic-compatible dataclass defining the output schema (DocumentStatus) returned by the 'Add Memory' tool.
    class DocumentStatus(BaseModel):
        id: int
        status: str
        collection: str
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It states the tool adds content but doesn't disclose behavioral traits like permissions needed, whether it's idempotent, rate limits, or what happens on success/failure. This is a significant gap for a mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with no wasted words. It's appropriately sized and front-loaded, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's mutation nature, lack of annotations, no output schema, and low schema coverage, the description is incomplete. It doesn't cover key aspects like return values, error handling, or detailed parameter usage, leaving the agent with insufficient context.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the schema provides no parameter details. The description mentions 'plain text document or memory' but doesn't explain the 'text' or 'title' parameters, their formats, or constraints. It adds minimal value beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Add') and resource ('a plain text document or memory to Hyperspell'), making the purpose evident. However, it doesn't explicitly differentiate from sibling tools like 'Add File' or 'Search Hyperspell', which could involve similar resources or actions.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites, context, or exclusions, leaving the agent to infer usage based on tool names alone.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/hyperspell/hyperspell-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server